Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review all dvc add examples throughout docs #1255 #1605

Merged
merged 2 commits into from
Jul 21, 2020

Conversation

sahilbhosale63
Copy link
Contributor

@sahilbhosale63 sahilbhosale63 commented Jul 20, 2020

#1255: Reviewed all the dvc add examples throughout docs. This issue is mentioned under Next priorities on GitHub.

@jorgeorpinel
Copy link
Contributor

Fix #1255

Please do not use that special word @sahilbhosale63, because the entire issue would be closed when/if this is merged.

Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great start. I left some specific comments on what to do in the 2 instances you found (just remove all the output, it will be easier to maintain these docs in the future this way) 👇

Other than that, I think there are other instances of $ dvc add that probably need some updates. Maybe not in the command or it's output themselves, but in related text of code blocks following. HOWEVER, these secondary updates are somewhat out of scope, since there's a separate checkbox in #1255 for that, so we can leave it for another separate PR if you prefer. Let's just double check that there's no other instances that actually need changes in the command itself or its output.

content/docs/command-reference/add.md Outdated Show resolved Hide resolved
content/docs/command-reference/unprotect.md Outdated Show resolved Hide resolved
@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Jul 21, 2020

Let's just double check that there's no other instances that actually need changes in the command itself or its output.

UPDATE: I looked over the entire 33 instances of $ dvc add and this is what I found:

  • /content/docs/command-reference/move.md:36 - the .dvc file that follows it in lines 42-8 needs to be updated (it should be much shorter now).
  • content\docs\start\data-versioning.md:36 - git add command in line 46 could be reordered (put .gitignore at the end).
  • content\docs\start\data-versioning.md:36 - same
  • content\docs\use-cases\shared-development-server.md:82 - isgit add in line 85 missing .gitignore?
  • content\docs\use-cases\versioning-data-and-model-files\index.md:46-7 - git add in line 63 could be reordered too.
  • content\docs\use-cases\versioning-data-and-model-files\tutorial.md"125/147 - reorder git add in 156. Maybe also put data before model (same in line 235)
  • content\docs\user-guide\dvc-files-and-directories.md:305 - probably remove ... line under it, and .dvc file example in lines 314-8 needs update
  • content\docs\user-guide\how-to\update-tracked-files.md:51 - is git add in line 52 missing .gitignore?

^ For all these it's necessary to follow the entire example/context in question to determine these questions, and make the necessary updates.

sahilbhosale63 added a commit to sahilbhosale63/dvc.org that referenced this pull request Jul 21, 2020
@jorgeorpinel jorgeorpinel merged commit 9debdc0 into iterative:master Jul 21, 2020
@jorgeorpinel
Copy link
Contributor

Thanks @sahilbhosale63 !

sahilbhosale63 added a commit to sahilbhosale63/dvc.org that referenced this pull request Jul 22, 2020
jorgeorpinel added a commit that referenced this pull request Jul 22, 2020
Review all dvc add examples throughout docs #1605
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants